home *** CD-ROM | disk | FTP | other *** search
/ Collection of Internet / Collection of Internet.iso / protocol / standard / iso / 9660 / rockridg / rrg.11 / api.cmd.nr < prev    next >
Encoding:
Text File  |  1992-08-19  |  7.6 KB  |  492 lines
  1. .sp
  2. .H 2 "Definition of CD-ROM Specific User Commands"
  3. .sp
  4. This sections provides manual pages which describe CD-ROM user commands
  5. for users in detail.
  6. The user commands are:
  7. .sp
  8. .TS
  9. center;
  10. l l.
  11. Name    Description
  12. \_    \_
  13.       
  14. cdsuf    Retrieve a System Use Field
  15.       
  16. cddevsuppl    Set and get major/minor numbers of a device file
  17. .TE
  18. .sp
  19. .bp
  20. .sp
  21. .H 3 "cdsuf command"
  22. .sp
  23. .in 0
  24. .ft 3
  25. NAME
  26. .ft 1
  27. .in 2
  28. .br
  29. .ft 3
  30. cdsuf
  31. .ft 1
  32. - read the System Use Fields from a System Use Area
  33. .sp
  34. .in 0
  35. .ft 3
  36. SYNOPSIS
  37. .ft 1
  38. .in 2
  39. .ft 3
  40. .br
  41. .ft 3
  42. cdsuf 
  43. .ft 1
  44. [-s number]  [-b]  file
  45. .sp
  46. .in 0
  47. .ft 3
  48. DESCRIPTION
  49. .ft 1
  50. .in 2
  51. .br
  52. This command is used to access the System Use Fields of the System Use
  53. Area associated with a File Section of a file or directory and to list
  54. its contents on standard output, following any Continuation Fields that
  55. may be present.
  56. .sp
  57. .in 0
  58. .ft 3
  59. OPTIONS
  60. .ft 1
  61. .in 2
  62. .br
  63. The following options are available:
  64. .VL 15 5
  65. .LI "\f3-s number\f1"
  66. This option specifies the File Section for which the System Use Area shall
  67. be read.
  68. The numbering starts with one.
  69. If this option is omitted the last File Section of that file is assumed.
  70. .LI "\f3-b\f1"
  71. With this option all of the System Use Fields of the System Use Area are 
  72. copied from the CD-ROM to standard output in binary format.
  73. .LE
  74. .sp
  75. .in 0
  76. .ft 3
  77. OPERAND
  78. .ft 1
  79. .in 2
  80. .br
  81. The operand
  82. .I file\^
  83. is the name of any file or directory within the CD-ROM file hierarchy.
  84. .sp
  85. .in 0
  86. .ft 3
  87. STDIN
  88. .ft 1
  89. .in 2
  90. .br
  91. Not Used.
  92. .sp
  93. .in 0
  94. .ft 3
  95. INPUT FILES
  96. .ft 1
  97. .in 2
  98. .br
  99. None.
  100. .sp
  101. .in 0
  102. .ft 3
  103. ENVIRONMENT VARIABLES
  104. .ft 1
  105. .in 2
  106. .br
  107. LC_TIME determines the format and contents of date and time strings. 
  108. If LC_TIME is not set in the environment or is set to the empty string,
  109. the value of LANG will be used as a default.
  110. If LANG is not set or set to the empty string, the corresponding
  111. value from the implementation-specific default locale will be used.
  112. If LC_TIME or LANG contain an invalid setting, the utility will behave
  113. as if none of the variables had been defined.
  114. .sp
  115. .in 0
  116. .ft 3
  117. STDOUT
  118. .ft 1
  119. .in 2
  120. .br
  121. The output is formatted in the form of a table which contains an entry
  122. for each System Use Field in the System Use Area as recorded on the CD-ROM.
  123. Each entry of the table shall have the fields
  124. .I Signature,\^
  125. .I Length,\^
  126. .I Version,\^
  127. and 
  128. .I Data\^ 
  129. as specified in the System Use Sharing Protocol.
  130. Whether to break up the 
  131. .I Data\^
  132. field into smaller fields according to the protocol which defined the
  133. .I Signature\^
  134. field is left up to the implementation.
  135. .sp
  136. If the 
  137. .ft 3
  138. -b 
  139. .ft 1
  140. option is applied, the contents of the full System Use Area
  141. are written to standard output in binary format as it is recorded on the CD-ROM.
  142. .sp
  143. .in 0
  144. .ft 3
  145. STDERR
  146. .ft 1
  147. .in 2
  148. .br
  149. Used only for diagnostic messages.
  150. .sp
  151. .in 0
  152. .ft 3
  153. OUTPUT FILES
  154. .ft 1
  155. .in 2
  156. .br
  157. None.
  158. .sp
  159. .in 0
  160. .ft 3
  161. EXIT STATUS
  162. .ft 1
  163. .in 2
  164. .br
  165. The following exit values are returned:
  166. .sp
  167. .VL 15 5
  168. .LI "0"
  169. successful completion
  170. .LI "1"
  171. file not found or file is not a file or directory within a CD-ROM file
  172. hierarchy or access denied
  173. .LI "2"
  174. File Section indicated by -s does not exist
  175. .LI "3"
  176. File Section indicated by -s has no System Use Area
  177. .LE
  178. .sp
  179. .in 0
  180. .ft 3
  181. CONSEQUENCES OF ERRORS
  182. .ft 1
  183. .in 2
  184. .br
  185. None.
  186. .sp
  187. .in 0
  188. .ft 3
  189. APPLICATION USAGE
  190. .ft 1
  191. .in 2
  192. .br
  193. The user must have read permission for
  194. .I file\^
  195. to execute the command successfully.
  196. .sp
  197. .in 0
  198. .ft 3
  199. EXAMPLES
  200. .ft 1
  201. .in 2
  202. .br
  203. None.
  204. .sp
  205. .in 0
  206. .ft 3
  207. FUTURE DIRECTIONS
  208. .ft 1
  209. .in 2
  210. .br
  211. None.
  212. .sp
  213. .in 0
  214. .ft 3
  215. SEE ALSO
  216. .ft 1
  217. .in 2
  218. .br
  219. None.
  220. .sp
  221. .in 0
  222. .ft 3
  223. CHANGE HISTORY
  224. .ft 1
  225. .in 2
  226. .br
  227. None.
  228. .sp
  229. .in 0
  230. .bp
  231. .sp
  232. .H 3 "cddevsuppl command"
  233. .sp
  234. .in 0
  235. .ft 3
  236. NAME
  237. .ft 1
  238. .in 2
  239. .br
  240. .ft 3
  241. cddevsuppl
  242. .ft 1
  243. - set and get the major and minor numbers of a device file
  244. .sp
  245. .in 0
  246. .ft 3
  247. SYNOPSIS
  248. .ft 1
  249. .in 2
  250. .br
  251. .ft 3
  252. cddevsuppl
  253. .ft 1
  254. [-m mapfile | -u unmapfile]  [-c]
  255. .sp
  256. .in 0
  257. .ft 3
  258. DESCRIPTION
  259. .ft 1
  260. .in 2
  261. .br
  262. This command is used to map and unmap the major and minor numbers of a device
  263. file on a mounted CD-ROM.
  264. .sp
  265. If
  266. .I cddevsuppl\^
  267. is executed without the
  268. .ft 3
  269. -m
  270. .ft 1
  271. or 
  272. .ft 3
  273. -u
  274. .ft 1
  275. option, it lists the current device file mappings
  276. on the system.
  277. .sp
  278. The \f3-m mapfile\f1 and \f3-u unmapfile\f1 options are mutually exclusive.
  279. .sp
  280. .in 0
  281. .ft 3
  282. OPTIONS
  283. .ft 1
  284. .in 2
  285. .br
  286. The following options are available:
  287. .VL 20 5
  288. .LI "\f3-m mapfile\f1"
  289. This option will map the major and minor numbers for device files.
  290. The mappings are specified in
  291. .I mapfile.\^
  292. This file has one entry for each device file mapping in the format:
  293. .sp
  294. .TS
  295. center;
  296. c c c.
  297. device_file_path    new_major    new_minor
  298. .TE
  299. .sp
  300. The fields are separated by white space.
  301. The entries are separated by newlines.
  302. Anything beyond the third field shall be treated as a comment.
  303. .sp
  304. The maximum number of mappings is defined in the header file
  305. .I <sys/cdrom.h>.\^
  306. A previous device file mapping for a specific device file is overridden 
  307. if that device file that is mapped again.
  308. .sp
  309. .LI "\f3-u unmapfile\f1"
  310. This option will unmap the major and minor numbers for device files.
  311. The mappings are specified in
  312. .I unmapfile.\^
  313. This file has one entry for each device file mapping in the format:
  314. .sp
  315. .TS
  316. center;
  317. c.
  318. device_file_path
  319. .TE
  320. .sp
  321. The entries are separated by newlines.
  322. Anything beyond the first field shall be treated as a comment.
  323. .sp
  324. .LI "\f3-c\f1"
  325. This option is only useful when used in combination with the
  326. \f3-m mapfile\f1 or \f3-u unmapfile\f1
  327. options.
  328. The
  329. .ft 3
  330. -c
  331. .ft 1
  332. option will cause
  333. .I cddevsuppl\^
  334. to continue processing the device file mappings if an error is returned
  335. for a specific device file mapping.
  336. An error message for that specific device file will be printed to
  337. standard error.
  338. The default action is to stop processing when an error has occurred.
  339. .LE
  340. .sp
  341. .in 0
  342. .ft 3
  343. OPERAND
  344. .ft 1
  345. .in 2
  346. .br
  347. None.
  348. .sp
  349. .in 0
  350. .ft 3
  351. STDIN
  352. .ft 1
  353. .in 2
  354. .br
  355. Not used.
  356. .sp
  357. .in 0
  358. .ft 3
  359. INPUT FILES
  360. .ft 1
  361. .in 2
  362. .br
  363. The input files are text files.
  364. .sp
  365. .in 0
  366. .ft 3
  367. ENVIRONMENT VARIABLES
  368. .ft 1
  369. .in 2
  370. .br
  371. No environment variables affect the execution of
  372. .I cddevsuppl.\^
  373. Note that LC_CTYPE will not be used in filename conversion.
  374. .sp
  375. .in 0
  376. .ft 3
  377. STDOUT
  378. .ft 1
  379. .in 2
  380. .br
  381. If no options are used the current device file mappings are listed on
  382. standard output.
  383. In the case of \f3-m mapfile\f1, the new setting is listed
  384. if the mapping was completed successfully.
  385. In the case of \f3-u unmapfile\f1, the device file and
  386. the major/minor numbers as recorded on the CD-ROM are listed if
  387. the unmapping was completed successfully.
  388. .sp
  389. .in 0
  390. .ft 3
  391. STDERR
  392. .ft 1
  393. .in 2
  394. .br
  395. Used only for diagnostic messages.
  396. .sp
  397. .in 0
  398. .ft 3
  399. OUTPUT FILES
  400. .ft 1
  401. .in 2
  402. .br
  403. None.
  404. .sp
  405. .in 0
  406. .ft 3
  407. EXIT STATUS
  408. .ft 1
  409. .in 2
  410. .br
  411. The following exit values are returned:
  412. .sp
  413. .VL 15 5
  414. .LI "0"
  415. successful completion
  416. .LI "1"
  417. file not found or file is not a file or directory within a CD-ROM file
  418. hierarchy or access denied
  419. .LI "2"
  420. not user with appropriate privileges
  421. .LI "3"
  422. too many mappings
  423. .LI "4"
  424. parameter error or bad format in a mapping file
  425. .LI "5"
  426. file is not a device file
  427. .LI "6"
  428. file not previously mapped
  429. .LE
  430. .sp
  431. .in 0
  432. .ft 3
  433. CONSEQUENCES OF ERRORS
  434. .ft 1
  435. .in 2
  436. .br
  437. None.
  438. .sp
  439. .in 0
  440. .ft 3
  441. APPLICATION USAGE
  442. .ft 1
  443. .in 2
  444. .br
  445. Only a user with appropriate privileges may change administrative CD-ROM
  446. features successfully.
  447. To read the current device file mappings, the user must have read
  448. permission on the device file.
  449. .sp
  450. Mappings should be established before affected device files are used.
  451. If the command is applied for device file mappings when device files 
  452. have already been opened, the
  453. effect of this command on these files is undefined.
  454. .sp
  455. The device file mappings for a mounted CD-ROM are eliminated when the
  456. CD-ROM is unmounted.
  457. .sp
  458. .in 0
  459. .ft 3
  460. EXAMPLES
  461. .ft 1
  462. .in 2
  463. .br
  464. None.
  465. .sp
  466. .in 0
  467. .ft 3
  468. FUTURE DIRECTIONS
  469. .ft 1
  470. .in 2
  471. .br
  472. None.
  473. .sp
  474. .in 0
  475. .ft 3
  476. SEE ALSO
  477. .ft 1
  478. .in 2
  479. .br
  480. None.
  481. .sp
  482. .in 0
  483. .ft 3
  484. CHANGE HISTORY
  485. .ft 1
  486. .in 2
  487. .br
  488. None.
  489. .sp
  490. .in 0
  491. .bp
  492.